home *** CD-ROM | disk | FTP | other *** search
/ MPEG Toolkit / MPEG Toolkit.iso / dos / ampeg43 / source / encodsrc / readme.txt < prev    next >
Encoding:
Text File  |  1997-01-01  |  6.9 KB  |  212 lines
  1.           INTERNATIONAL ORGANIZATION FOR STANDARDIZATION
  2.            ORGANISATION INTERNATIONALE DE NORMALISATION
  3.                                ISO/IEC JTC1/SC29/WG 11
  4.             CODING OF MOVING PICTURES AND ASSOCIATED AUDIO
  5.  
  6.                                 MPEG92/
  7.                                 Nov. 1992
  8.  
  9. Source: Davis Pan (Digital Equipment Corporation),
  10.             Chairman of the MPEG/audio ad hoc committee on software
  11.             simulation
  12. Title: Working Draft of MPEG/Audio Technical Report
  13.  
  14. Disclaimer of Warranty
  15.     These software programs are available to the user without any 
  16. license fee or royalty on an "as is" basis.  ISO disclaims any and all 
  17. warranties,  whether express, implied, or statuary, including any 
  18. implied warranties or merchantability or of fitness for a particular 
  19. purpose.  In no event shall ISO be liable for any incidental, punitive, 
  20. or consequential damages of any kind whatsoever arising from the 
  21. use of these programs.
  22.  
  23.     This disclaimer of warranty extends to the user of these 
  24. programs and user's customers, employees, agents, transferees, 
  25. successors, and assigns,
  26.  
  27.     ISO does not represent or warrant that the programs furnished 
  28. hereunder are free of infringement or any third-party patents, 
  29. copyrights or trade secrets.
  30.  
  31.     The purpose of this software is to provide a tool to help in the 
  32. learning and understanding of the MPEG/audio compression and 
  33. decompression algorithm.  It is not an efficient implementation.
  34.  
  35. Organization of this Report
  36.  
  37.     The main body of this report describes the organization and 
  38. use of the software.  The listings of the software, sample makefiles, 
  39. and test bitstreams are contained in the appendices:
  40.  
  41.     Appendix  A contains the source code for the MPEG/audio 
  42. software, written in the C programming language.  This software has 
  43. been run and verified a large variety of computers and operating 
  44. systems.
  45.  
  46.     Appendix B contains sample "makefiles" which can be used to
  47. compile the software.  Before compiling, please examine the file
  48. common.h to determine if any of the "#define" declarations should be
  49. reactivated by removing it from a comment statement.
  50.  
  51.     Appendix  C contains a minimal bitstream test that can be used 
  52. to verify the proper operation of the MPEG/audio software.  The 
  53. bitstream test consists of three bitstreams:
  54.    orig.mpg    - The original, coded MPEG/audio bitstream
  55.    deco.dec    - The audio data resulting from decoding orig.mpg
  56.    renc.dec    - The encoded MPEG/audio bitstream obtained by 
  57.            encoding deco.dec
  58.  
  59.     The software is functioning properly if the following equations
  60. hold:
  61.      a. decoded(orig.mpg) == deco.dec
  62.         byte-swapping of deco.dec will be necessary for this 
  63.        equation to hold for little-endian computers
  64.     b. encoded(deco.dec) == renc.mpg
  65.  
  66.         (encode with the default options except for the following:
  67.         48 kHz sampling rate and 256 kbits/sec coded bit rate)
  68.  
  69.     If the bitstream tests fail, make sure that the following 
  70. variable types have at least the precision listed below:
  71.  
  72.     integer    -    16 or 32bits
  73.     float    -    32 bits
  74.     double    -    64 bits.
  75.  
  76. Electronic Distribution
  77.  
  78.     All the data listed above may be obtained in electronic form 
  79. (e-mail) by contacting
  80. :
  81.      Mr. Frank Laczko
  82.      tel:        214-997-3988
  83.      FAX:        214-997-5763
  84.      e-mail:    frank@laczko.ti.com
  85.  
  86.     Other electronic distribution methods may become available 
  87. soon.  Managers of public access FTP sites  are encouraged to make 
  88. this software available on their sites.
  89.  
  90. Organization of the Code
  91.  
  92. The MPEG/audio Layer 1 and Layer 2 ** software package consists 
  93. of: 
  94.     21 data files tables
  95.     8 source files (*.c)
  96.     3 definitions files (*.h)
  97.     3 test bitstreams
  98.     * makefiles
  99.  
  100. ** The layer 3 software is currently work in progress and will be 
  101. included in a future revision of this report.
  102.  
  103. Table 1 illustrates how the encoder and decoder is formed from the 
  104. component files.  In this table the definition files are enclosed in 
  105. parenthesis and listed immediately below the primary source file 
  106. which uses them.  The data file names are listed within braces and 
  107. also placed immediately below the source file which uses them.
  108.  
  109.             Table 1
  110.  
  111. encoder            common            decoder
  112. files            files            files
  113. ----------      ------------    ------------
  114. musicin.c        common.c        musicout.c
  115. encode.c        (common.h)        decode.c
  116. (encoder.h)     {alloc_0}          (decoder.h)
  117. {enwindow}        {alloc_1}        {dewindow}
  118. psy.c, subs.c    {alloc_2}
  119. {absthr_0}        {alloc_3}
  120. {absthr_1}
  121. {absthr_2}
  122. tonal.c
  123. {1cb0}, {1cb1}, {1cb2}
  124. {2cb0}, {2cb1}, {2cb2}
  125. {1th0}, {1th1}, {1th2}
  126. {2th0}, {2th1}, {2th2}
  127.  
  128. Running the Software
  129.  
  130. To run this software, compile the programs to form an encoder 
  131. executable file, musicin, and a decoder executable file, musicout.
  132.     To run the code type the name of the file followed by a 
  133. carriage return.  The programs will prompt you to input the 
  134. appropriate parameters.  The sound input file for the encoder should 
  135. be sound data, monophonic or stereophonic, sampled at 32, 44.1, or 
  136. 48 kHz with 16 bits per sample.  For stereophonic data the left 
  137. channel sample should precede the right channel sample.  The sound 
  138. output file of the decoder will be the same format as the sound input 
  139. file used by the decoder,  except for possible byte order differences 
  140. if the encoder and decoder programs are run on different computer
  141. systems which have different byte ordering conventions.
  142.  
  143.         Special notes for MSDOS users:
  144. 1. The default bitrate option does not work.
  145. 2. The input/output filename defaults not compatible with MSDOS.
  146. 3. Use the large memory model for compilation.
  147.  
  148. Notes on the Software
  149.  
  150.     The encoder and decoder software are configured to output the
  151. coded audio bitstreams as a string of hexadecimal ascii characters. 
  152. For greater compression efficiency,  compile flag, BS_FORMAT, in 
  153. common.h can be switched to configure the bitstream reading and 
  154. writing routines to process raw binary bitstreams.
  155.  
  156.     The decoder program has a very crude implementation of 
  157. bitstream synchword detection.  It may not be able to correctly 
  158. decode valid bitstreams which have false synchword patterns in the 
  159. ancillary data portion of the bitstream.
  160.  
  161. Appendix A MPEG/audio Source Code
  162. (included elsewhere)
  163.  
  164. Appendix B Sample "makefiles"
  165. (included elsewhere)
  166.  
  167. Appendix C Test Bitstreams
  168. (included elsewhere)
  169.  
  170. Appendix D List of Contributors
  171. Bill Aspromonte
  172. Shaun Astarabadi
  173. R. Bittner
  174. Karlheinz Brandenburg
  175. W. Joseph Carter
  176. Jack Chang
  177. Mike Coleman
  178. Johnathan Devine
  179. Ernst Eberlein
  180. Dan Ellis
  181. Peter Farrett
  182. Jean-Georges Fritsch
  183. Vlad Fruchter
  184. Hendrik Fuchs
  185. Bernhard Grill
  186. Amit Gulati
  187. Munsi Haque
  188. Chuck Hsiao
  189. Toshiyuki Ishino
  190. Masahiro Iwadare
  191. Earl Jennings
  192. James Johnston
  193. Leon v.d. Kerkhof
  194. Don Lee
  195. Mike Li
  196. Yu-Tang Lin
  197. Soren Neilsen
  198. Simao F. Campos Neto
  199. Mark Paley
  200. Davis Pan
  201. Tan Ah Peng
  202. Kevin Peterson
  203. Juan Pineda
  204. Ernst F. Schroeder
  205. Peter Siebert
  206. Jens Spille
  207. Sam Stewart
  208. Al Tabayoyon
  209. Kathy Wang
  210. Franz-Otto Witte
  211. Douglas Wong
  212.